4.8.1 查询用户目录列表

基本信息 查询所有用户目录的信息,config包含各种用户目录的具体配置 Path: /api/v1/userDirectory/queryAll

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
pageSize 非必须 20 每页数据数目
pageIndex 非必须 1 当前页 从1开始
filter 非必须 name 过滤条件,只能从 ['all', 'name', 'description']中选择。不传或者传空表示不添加过滤条件,即查询全部。
searchValue 非必须 test 搜索关键字,不传或者传空表示不添加过滤条件,即查询全部
sortBy 非必须 排序字段
asc 非必须 排序方式,1升序,0降序,默认升序
isPage 非必须 '0'不需要分页,'1' 需要分页

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须 返回编码 0 成功 其它值,失败
data object 非必须 数据主体
├─ data object [] 非必须 用户目录列表,数组对象 item 类型: object
├─ ├─ id string 必须 主键
├─ ├─name string 必须 用户目录名称
├─ ├─type string 必须 用户目录类型 示例:ldap
├─ ├─authComposeId string 必须 认证策略ID
├─ ├─domain string 必须 唯一标识
├─ ├─authServerList object [] 必须 已绑定的认证服务器i
├─ ├─ ├─id string 必须 认证服务器ID
├─ ├─ ├─name string 必须 认证服务器名称
├─ ├─ ├─authType string 必须 认证类型
├─ ├─ ├─subtype string 必须 认证子类型 示例:ldap
├─ ├─ ├─status number 必须 认证服务器状态
├─ ├─description string 必须 描述
├─ ├─ config object 必须 用户目录配置
├─ count number 非必须 数据总数
├─ pageIndex number 非必须 当前页码,从1开始
├─ pageSize number 非必须 分页大小,默认20
├─ pageCount number 非必须 分页数
msg string 非必须 code对应的提示信息  

返回示例

{
    "code": 0,
    "data": {
        "pageSize": 20,
        "pageIndex": 1,
        "count": 2,
        "pageCount": 1,
        "data": [
            {
                "id": "c1085980-a3da-11eb-ab69-8353f1c26be3",
                "name": "idldap-test",
                "description": "",
                "domain": "idldap-test.com",
                "authComposeId": "c109e020-a3da-11eb-ab69-8353f1c26be3",
                "type": "ldap",
                "authServerList": [
                    {
                        "id": "e4e65370-a3da-11eb-ab69-8353f1c26be3",
                        "name": "idldap-test",
                        "authType": "auth/psw",
                        "subtype": "ldap",
                        "status": "1"
                    }
                ],
                "config": {
                    "type": "ad",
                    "syncConfig": {
                        "syncTime": {
                            "period": 86400000
                        },
                        "cleanDeleted": {
                            "enable": 1,
                            "interval": 168
                        }
                    },
                    "templateId": "3b52d0e4-e178-4bef-aef2-95eaf91adeeb",
                    "interfaceStatus": 1,
                    "externalUserServerConfig": {
                        "type": "ad",
                        "pwdModel": "rsa",
                        "serverIp": "192.168.1.2",
                        "directory": {
                            "type": "ldap",
                            "subtype": "default"
                        },
                        "bandFilter": "(&(CN=*)&(ObjectClass=group))",
                        "reqTimeout": "15",
                        "userFilter": "(objectCategory=person)",
                        "groupFilter": "(ou=*)",
                        "adminAccount": "test@test.com",
                        "adminPassword": "gl!@#157",
                        "serverAddress": "ldap://192.168.1.2",
                        "sAMAccountName": "sAMAccountName",
                        "searchEntrance": "OU=dyx,DC=lichee,DC=com",
                        "serverProtocol": "ldap://",
                        "bandAttrMapping": {
                            "name": "cn",
                            "externalId": "objectGUID",
                            "description": "description"
                        },
                        "interfaceStatus": 1,
                        "userAttrMapping": {
                            "band": "memberOf",
                            "path": "ou",
                            "email": "mail",
                            "phone": "telephoneNumber",
                            "status": "userAccountControl",
                            "externalId": "objectGUID",
                            "description": "description",
                            "expiredTime": "accountExpires"
                        },
                        "groupAttrMapping": {
                            "name": "ou",
                            "externalId": "objectGUID",
                            "description": "description"
                        }
                    },
                    "forbidUnimportedUserLogin": 1
                }
            },
            {
                "id": "42382050-a339-11eb-a660-cf95cef4584f",
                "name": "dyx-test",
                "description": "",
                "domain": "dyx.com",
                "authComposeId": "4238e3a0-a339-11eb-a660-cf95cef4584f",
                "type": "custom",
                "config": {
                    "interfaceStatus": 0,
                    "forbidUnimportedUserLogin": 1
                }
            },
        ]
    },
    "msg": "请求成功"
}

错误信息

错误提示 错误码
不支持的搜索内容 7201
不支持的排序内容 7201
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-11-20 11:03

results matching ""

    No results matching ""